This API will allows you to view/get the Payment Methods info from Salesforce
URL
https://[localhost]:[port]/dxp-ux/v1/{businessId}/paymentmethod
URL PARAMS
| name | type | description | required |
|---|
| businessId | string | 2 letter ISO 3166 country code (PR) identifying the business unit. | Y |
| name | value | description | required |
|---|
| X-Correlation-ID | String | This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers.
Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b
| N |
| client_id | String | The client_id identifying the channel. Minimum
| Y |
| client_secret | String | The client_id identifying the channel. Minimum
| Y |
Query Param
| name | type | description | required |
|---|
| accountId | string | billing account number (BAN-CAN),
(either msisdn or billingAccountNumber is mandatory) | Y* |
| account.relatedParty.id | string | Mobile Device number (either msisdn or billingAccountNumber is mandatory) | Y* |
| relatedParty.name | string | Name of the relatedParty to search. Could be different, depending on the use case. For Peacock Mobile Project the value is IVR/Digital". | Y |
| relatedParty.@type | string | The type of the relatedParty. For Peacock Mobile Project the values must be channel | Y |
cURL request
curl --location 'https:
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92cDD' \
--header 'client_id: 12345' \
--header 'client_secret: abcde'
Response success
[ 200 ]
[
{
"id":"PM-a6I3K0000008znQUAQ",
"token": "cGF5bWVudG1ldGhvZF9jY181a25obmtzZg",
"@type":"Tokenised Credit Card",
"@baseType": "paymentMethod",
"account": [
{
"id": "31516278-31514752",
"@type": "BillingAccount",
"ratingType":"postpaid",
"autopayEnabled": "true"
}
],
"relatedParty":[{
"name": "BrainTreeToken",
"@type": "paymentGatewayType"
}],
"autopayEnabled": "true"
}
]
Definitions
| name | type | description | required |
|---|
| id | string | payment method external identifier from billing system | N |
| token | string | payment method token in payment method gateway | N |
| @type | string | Describes the type of card | N |
| @baseType | string | Describes the base type of card | N |
| account | string | Describes the account details | N |
| account.id | string | Billing Account Number | N |
| account.@type | string | Describes the type of account | N |
| account.ratingType | string | customer payment type, Eg: Prepaid/Postpaiod | N |
| account.autopayEnabled | string | indicates if the billing account supports automatic payments | N |
| relatedParty | string | Describes related party | N |
| relatedParty.name | string | payment method gateway type, Eg: BrainTreeToken/Evertec | N |
| relatedParty.@type | string | Describes the type of related party | N |
| autopayEnabled | string | indicator for the payment method used for autopay | N |